home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 05.zip / BS1 part 5 / BaudBandit.adf / REXX / ARexx.doc < prev    next >
Text File  |  1992-04-16  |  20KB  |  640 lines
  1. BaudBandit 2.0 ARexx docs
  2.  
  3. ARexx port/Public screen name is "BAUD"
  4.  
  5.  
  6. Coomand summary...
  7.  
  8. Command     Short    Argument(s)            Returns
  9. --------------------------------------------------------------------------
  10. AddPairs    AD    '{?=!}<?=!}....'
  11. Ansi        ANSI    ON | OFF
  12. Answer        ANSW    ON | OFF
  13. ASend        AS    path+filename
  14. Auto        AU    ON | OFF
  15. BaudRate    BA    [baud]                RESULT = baud
  16. Beep        BE    [tone]
  17. BufferSize    BU    [size in bytes]         RESULT = size
  18. CaptName    CAPTN    path+name
  19. CaptWrap    CAPTW    ON | OFF
  20. Capture     CA    [ON | OFF | path+filename]     RC = open
  21. ChatMode    CH    ON | OFF | lines        RC = open
  22. Count        CO
  23. Cursor        CU    [row col]            RESULT=current row & col
  24. DataPath     DA    path
  25. DCD        DCD                    RC = Carrier
  26. DCDHi        DCDH    string
  27. DCDLow        DCDL    string
  28. Delay        DEL    OFF | 0-15
  29. Depth        DEP    1-3                RC = depth
  30. Device        DEV    ['device/unit/priority']    RC = error/shared
  31. Dial        DIAL    pattern             RC = found name
  32. DialClear    DIALC
  33. DialSelect    DIALS    pattern
  34. Display     DIS    ON | OFF
  35. Download    DO    filename            RC = aborted
  36. FKey        FK    'F# string'
  37. Font        FO    'font/size'
  38. GetFile     GETF    'Title,path+name/pattern'    RESULT = path+name
  39. GetLine     GETL    [lines back]             RESULT = line
  40. Handshake    HA    X/N/C/B
  41. Hilite        HI    string                RC = count
  42. History     HIST    string
  43. Lace        LA    ON | OFF | HALF
  44. LoadConfig    LOADC    path+name
  45. LoadKeys    LOADK    path+name
  46. LoadPhone    LOADP    path+name
  47. Log        LOG    [ON | OFF | text]         RC=open
  48. Map        MAP    map array
  49. Mask        MAS    ON | OFF
  50. Menu        ME    'Menu,Item,string' | RESET
  51. Msg        MS    string
  52. MsgRAW        MSGR    string
  53. OutPre        OU    string
  54. Pairs        PA    '{?=!}{?=!}{?=!}...'
  55. PopUp        PO    ON | OFF
  56. Priority    PR    value
  57. QueueDial    QUE
  58. Quickrend    QUIC    ON | OFF
  59. Quiet        QUIE    ON | OFF
  60. Quit        QUIT    [UNDO]
  61. Remote        REM    ON | OFF | Welcome | Pass | Super | ULPath | DLPath
  62. Review        REV    Open | Close | Refresh        RC=open
  63. SaveConfig    SAVEC    [path+name]
  64. SaveKeys    SAVEK    [path+name]
  65. SavePhone    SAVEP    [path+name]
  66. Screen        SC    [ON | OFF]            RC=open
  67. Send        SEN    string
  68. Set        SET    options
  69. SetMark     SETM    [pattern]             RC=success
  70. Suspend        SU    ON | OFF
  71. Status        ST    option                RESULT=string
  72. Timeout     TI    OFF | seconds
  73. TrueLF        TR    ON | OFF
  74. Undo        UN    string
  75. UpLoad        UP    file,[file]...            RC=aborted
  76. Wait        WA    string,[string]...        RC=timeout, RESULT=which
  77. Wrap        WR    ON | OFF | columns
  78.  
  79. Commands, and examples
  80. --------------------------------------------------------------------------
  81. AddPairs    Add script pairs without disturbing any current pairs
  82.  
  83. AddPairs '<continue=\r}{??:=\r}'
  84.  
  85. See also: Pairs
  86. --------------------------------------------------------------------------
  87. Ansi        turn IBM ANSI (alternate configuration) on/off
  88.  
  89. Ansi ON     on
  90. Ansi OFF    off
  91.  
  92. --------------------------------------------------------------------------
  93. Answer        turn on/off sending of 'Answer' configuration macro.
  94.         (Default is execution of remote BBS program)
  95.  
  96. Answ ON        on
  97. Answ OFF     off
  98.  
  99. --------------------------------------------------------------------------
  100. AsciiSend    Start an ASCII file send.
  101.  
  102. ASend 'RAM:file' Start sending RAM:file
  103. ASend        stop send
  104.  
  105. See also: Delay
  106. --------------------------------------------------------------------------
  107. Auto        Turn Auto-PhoneBook on/off
  108.  
  109. Auto ON        PhoneBook will pop up on BUSY, NO CARRIER, or NO DIALTONE
  110. Auto OFF    Disable this feature
  111.  
  112. --------------------------------------------------------------------------
  113. BaudRate    Change baud rate
  114.  
  115. Baud 2400    Set BPS to 2400.  Odd rates are not restricted.
  116. Baud        Returns baud rate in the RESULT variable.
  117.  
  118. --------------------------------------------------------------------------
  119. Beep
  120.  
  121. Beep        Beep with normal tone (900)
  122. Beep 250    Beep with a different tone
  123. Beep 10000+200    Beep with new chirp (10000+n)
  124.  
  125. --------------------------------------------------------------------------
  126. Buffer        Change review/capture buffer size
  127.  
  128. Buf 32768    Change buffer size to 32K bytes.
  129. Buf        Returns buffer size in RESULT
  130.  
  131. --------------------------------------------------------------------------
  132. CaptName    Set the capture filename without opening
  133.  
  134. CaptN 'RAM:Capt'
  135.  
  136. See also: Status C, Capture
  137. --------------------------------------------------------------------------
  138. Capture     Change capture filename, and turn on/off
  139.  
  140. Capt        returns status of capture in RC
  141. Capt ON     On using default capture file
  142. Capt OFF    Turns capture off
  143. Capt 'RAM:Capt' on with a new filename. Closes current capture.
  144.         Appends if the file exists.
  145. Capt 'T:Capt.1' Incremental capture.  Number extension will increase
  146.         if file exists.
  147.  
  148. See also: Status C, Suspend, CaptName
  149. --------------------------------------------------------------------------
  150. CaptWrap    Turn on/off review buffer/capture word wrapping
  151.  
  152. CaptWrap ON    Turn on review buffer and capture word wrap
  153. CaptWrap OFF    Turn this feature off
  154.  
  155. --------------------------------------------------------------------------
  156. ChatMode    Turn chat mode on/off
  157.  
  158. Chat ON        on
  159. Chat OFF    off
  160. Chat 10     on with 10 line chat window
  161. Chat        Returns open state in RC
  162.  
  163. See also: Undo
  164. --------------------------------------------------------------------------
  165. Count        Returns count of pending ARexx child programs launched
  166.         from BB in the RC variable.
  167. Count
  168.  
  169. --------------------------------------------------------------------------
  170. Cursor        Get cursor postion or set MSG position.
  171.  
  172. Cursor        Returns current row/column position of cursor in RESULT.
  173. Cursor 0 0    Remove cursor reposition settings.
  174. Cursor 10 10    Set position for MSG command.
  175.  
  176. See also: Msg
  177. --------------------------------------------------------------------------
  178. DataPath    Change data path for uploads and downloads
  179.  
  180. Data 'RAM:'
  181.  
  182. --------------------------------------------------------------------------
  183. DCD        Data Carrier Detect
  184.  
  185. DCD        returns status of carrier in RC
  186.  
  187. --------------------------------------------------------------------------
  188. DCDHi        Set DCDHi macro
  189.  
  190. DCDH '\mTest.baud' Puts this string in the DCDHi config macro
  191.  
  192. --------------------------------------------------------------------------
  193. DCDLow        Set DCDLow macro
  194.  
  195. DCDL '\mDCDLow.baud' Puts this string in the DCDLow config macro
  196.  
  197. --------------------------------------------------------------------------
  198. Delay        Text send delay (0-15)
  199.  
  200. Del 0        Fast - line at a time
  201. Del 1        Fast - char at a time
  202.  
  203. See also: ASend
  204. -----------------------------------------------------------------------------
  205.  
  206. Depth        Change screen depth
  207.  
  208. Dep 1        2 colors
  209. Dep 2        4 colors
  210. Dep 3        8 colors
  211. Dep        Returns current depth in RC.
  212.  
  213. See also: Lace
  214. --------------------------------------------------------------------------
  215. Device        Change the serial device
  216.  
  217. Dev        Status returned in RC
  218. Dev 'serial'    For "serial.device", unit 0
  219. Dev 'serial/1'    For "serial.device", unit 1
  220. Dev 'serial/0/8' For "serial.device", unit 0, priority 8
  221. Dev 'foo'    Will close the serial device, and stop all serial I/O
  222.  
  223. Return codes:    0 = Opened OK.
  224.         1 = Failed to open.
  225.         2 = Opened but sharing with something else.
  226.  
  227. See also: Status S, Quiet
  228. --------------------------------------------------------------------------
  229. Dial        Dial a name in current phone book
  230.  
  231. Dial 'portal'    dials the first entry with 'portal' anywhere.
  232. Dial 'p??tal'    would find the same
  233.  
  234. --------------------------------------------------------------------------
  235. DialClear    Clears all names in current phone book
  236.  
  237. DialClr
  238.  
  239. --------------------------------------------------------------------------
  240. DialSelect    Select multiple names in current phone book without dialing
  241.  
  242. DialSel '2400'    Selects all 2400 baud entries.
  243.         Send '\an'  to dial thru list
  244.         Send '\ar'  to dial/redial
  245.         QueueDial   to auto-dial
  246.  
  247. --------------------------------------------------------------------------
  248. Display     Suppress display of text from serial device
  249.  
  250. Display on    Suppress text display.  Text will still be captured.
  251. Display off    Resume text display
  252.  
  253. --------------------------------------------------------------------------
  254. Download    Start download
  255.  
  256. Down 'file.arc' Download to the current datapath as 'file.arc'
  257.         using the current transfer protocol.
  258.  
  259. See also: DataPath, UpLoad, Set
  260. --------------------------------------------------------------------------
  261. FKey        Change contents of a function key, same format as .Keys file
  262.  
  263. FKey 'S10 Hi\r' Shift F10 will be changed.
  264.  
  265. --------------------------------------------------------------------------
  266. Font        Change font
  267.  
  268. Font 'Clean/8'    Clean.font, 8 point
  269.  
  270. See also: Status F
  271. --------------------------------------------------------------------------
  272. GetFile     Use the BB file requestor from ARexx.
  273.  
  274. GetF 'File to delete'        The title will be 'File to delete'
  275.                 The path will be the the current data path.
  276.  
  277. GetF 'Enter Name,RAM:Capture'    Path is RAM:, Capture will be in the file
  278.                 string.
  279.  
  280. GetF 'Enter Name,RAM:Cap#?'    Path is RAM:, only matched files displayed.
  281.  
  282. 'OPTIONS RESULTS' must be set.
  283. Results:
  284.     The full path will be returned in RESULT
  285.     If 'Cancel' is selected, then result will be blank.
  286.  
  287. See also: Status N, Status X
  288. --------------------------------------------------------------------------
  289. GetLine     get a line from the review buffer
  290.  
  291. GetLine     Returns a line from the review buffer, incrementing an
  292.         internal marker by one line.
  293.  
  294. GetLine 1    Will get the last line returned
  295. GetLine 2    Will decrement by one line each time
  296.  
  297. 'OPTIONS RESULTS' must be set.
  298. Results:
  299.     The current line, starting at the line when SetMark was called,
  300.     will be in RESULT.
  301.     if '+EOB+' is returned, the mark has reached the end or start of
  302.     the buffer.
  303.  
  304. See also: SetMark, Review
  305. --------------------------------------------------------------------------
  306. Handshake    Change handshake mode
  307.  
  308. Hand N        None
  309. Hand X        xON/xOFF
  310. Hand C        CTS/RTS
  311. Hand B        Both
  312.  
  313. --------------------------------------------------------------------------
  314. Hilite        Highlight a string on occurrence/Check count
  315.  
  316. Hi 'Amiga'    Any occurrence of 'Amiga' will be highlighted.
  317.         If the string exists, a count is returned (in rc) and this
  318.         hilite is removed.
  319.  
  320. Hi        Clear all hilites.
  321.  
  322. -----------------------------------------------------------------------------
  323. History     Load History buffer (4K limit)
  324.  
  325. Hist string    Load buffer with lines separated by linefeeds.
  326. Hist        clear history
  327.  
  328. See also: Status H
  329. --------------------------------------------------------------------------
  330. Lace        Turn interlace on/off
  331.  
  332. Lace ON     on
  333. Lace OFF    off
  334. Lace HALF    interlace, half height
  335.  
  336. --------------------------------------------------------------------------
  337. Log        Turn log on/off or write a string
  338.  
  339. Log ON        on
  340. Log OFF     off
  341. Log 'Hello!'    Write a string to log file (time stamped)
  342.  
  343. --------------------------------------------------------------------------
  344. LoadConfig    Load new configuration
  345.  
  346. LoadC        Load the default file (last file loaded or saved)
  347. LoadC 'S:BB.Config' Load the named file
  348.  
  349. See also: SaveConfig
  350. --------------------------------------------------------------------------
  351. LoadKeys    Load a key macro file
  352.  
  353. LoadK        Load the default file (last file loaded or saved)
  354. LoadK 'S:keys'    Load the named file
  355.  
  356. See also: Status M, SaveKeys
  357. --------------------------------------------------------------------------
  358. LoadPhone    Load a phonebook file
  359.  
  360. LoadP        Load the default file
  361. LoadP 'S:Phone' Load the named file
  362.  
  363. See also: Status P, SavePhone
  364. --------------------------------------------------------------------------
  365. Map        Change the ANSI remapping table (current IBM/AMIGA config)
  366.  
  367. Map '0123456711'
  368.  
  369. --------------------------------------------------------------------------
  370. Mask        Turn 7 bit character mask on/off
  371.  
  372. Mask ON     on
  373. Mask OFF    off
  374.  
  375. --------------------------------------------------------------------------
  376. Menu        Add a menu item
  377.  
  378. Menu RESET    Removes all user menus
  379.  
  380. Menu 'User, Send Name, Greg Cunningham\r'
  381.  
  382.         Adds a menu strip named "User" with a menu item named
  383.         "Send Name" which will send "Greg Cunningham" with a
  384.         carriage return.
  385.  
  386. --------------------------------------------------------------------------
  387. Msg        Display a message on screen
  388.  
  389. Msg 'Hello'
  390. MsgRaw str    Display without carriage return.
  391.  
  392. --------------------------------------------------------------------------
  393. OutPre        Set pre-insert output string for ASCII Send and Buffer Send
  394.  
  395. Out '> '    Each line will begin with '> '
  396. Out '\mFoo'    Foo.baud will be executed before sending each line.
  397.  
  398. See also: Status O
  399. --------------------------------------------------------------------------
  400. Pairs        Set/reset script pairs
  401.  
  402. Pairs '{name=\r}{??:=\r}' Clear any old pairs.  Initiate new pairs.
  403. Pairs              Reset pairs to those in last dialed phonebook entry.
  404. Pairs ' '          Clear all pairs.
  405.  
  406. See also: AddPairs
  407. --------------------------------------------------------------------------
  408. PopUp        Turn on/off screen pop-up after transfers
  409.  
  410. Popup ON    turn this feature on
  411. Popup OFF    turn it off
  412.  
  413. --------------------------------------------------------------------------
  414. Priority    Change the task priority of BaudBandit ( -20 to 20 )
  415.  
  416. Pri 1        Set the priority to 1
  417. Pri (-7)    Negatives must be in quotes, parens, or use 0-n
  418.  
  419. --------------------------------------------------------------------------
  420. Quiet        Suppress communication between BaudBandit and serial device
  421.  
  422. Quiet ON     Suppress serial I/O
  423. Quiet OFF    Resume serial I/O
  424.  
  425. --------------------------------------------------------------------------
  426. QuickRend    Turn quickrend option on/off
  427.  
  428. QuickRend ON
  429. QuickRend OFF
  430.  
  431. --------------------------------------------------------------------------
  432. Quit        Terminate BaudBandit
  433.  
  434. Quit        ""
  435. Quit UNDO    Abort a quit.
  436.  
  437. --------------------------------------------------------------------------
  438. QueueDial    Start dial queue of all selected phonebook entries
  439.  
  440. QueueDial    Start the queue
  441.  
  442. See also: DialSelect
  443. --------------------------------------------------------------------------
  444. Remote        All character from the serial device and keyboard are
  445.         displayed on the screen and sent to the serial device.
  446.  
  447. Remote ON    Turn remote echo on.
  448. Remote OFF    Turn remote echo off.
  449.  
  450. --------------------------------------------------------------------------
  451. Review        Review window control
  452.  
  453. Rev Open    Open the review window at the current SetMark position
  454. Rev Close    Close the review window
  455. Rev Refresh    Refresh the review window at the current SetMark position
  456. Rev        If RC=1 then the review window is open
  457.  
  458. See also: SetMark, GetLine
  459. --------------------------------------------------------------------------
  460. SaveConfig    Save current configuration
  461.  
  462. SaveC        saves to default file
  463. SaveC filename
  464.  
  465. --------------------------------------------------------------------------
  466. SaveKeys    Save key macros to a file
  467.  
  468. SaveK        Save as default file (or last name used)
  469. SaveK 'S:keys'    Save keys as the named file
  470.  
  471. See also: Status M, LoadKeys
  472. --------------------------------------------------------------------------
  473. SavePhone    Save the phonebook to a file
  474.  
  475. SaveP        Save as default file (or last name used)
  476. SaveP 'S:Phone' Save as named file
  477.  
  478. See also: Status P, LoadPhone
  479. --------------------------------------------------------------------------
  480. Screen        Open/Close the BaudBandit screen (Iconify)
  481.  
  482. Screen        returns open status in RC
  483. Screen on    open the screen if closed
  484. Screen off    close the screen if open
  485.  
  486. --------------------------------------------------------------------------
  487. Send        Send a text string (formatted)
  488.  
  489. Send 'Hello\r'    sends the string out serial port with carriage return.
  490. Send '\Ac-'    turn capture on with default filename.
  491. Send '\az\ai\at' zero buffer, copy clip to buffer, and transmit
  492.  
  493. --------------------------------------------------------------------------
  494. Settings    Change settings (characters may be in any order)
  495.  
  496. Set 8N1     8 bit, no parity, 1 stop bit
  497. Set A        ZModem auto receive
  498. Set H        Half duplex
  499.  
  500. Name        Options        Description
  501. ---------    ----------    -----------
  502. Data bits    7/8
  503. Parity        N/O/E/M/S    None/Odd/Even/Mark/Space
  504. Stop bits    1/2
  505. CharMask    C/c        on/off
  506. Duplex        H/F        Half/Full
  507. IBM mode    I/i        on/off
  508. Protocol    W/x/X/Y/K/    WXModem/XModem/XModem-CRC/YModem/XModem-1K/
  509.         G/Z/A/R/B     YModem-GZModem/ZModem-Auto/Kermit/CIS-B Plus
  510.  
  511. --------------------------------------------------------------------------
  512. SetMark     set the GetLine / Review window mark
  513.  
  514. SetMark     Set the mark to current capture position (end of buffer)
  515. SetMark 'He?lo' if RC=1 then GetLine will return the last line with 'Hello'
  516.         in it.
  517.  
  518. See also: GetLine, Review
  519. --------------------------------------------------------------------------
  520. Suspend     Turn capture suspend on/off
  521.  
  522. Sus ON        Turn suspend on
  523. Sus OFF     Turn suspend off
  524.  
  525. See also: Capture
  526. --------------------------------------------------------------------------
  527. Status        Get status
  528.  
  529. Stat A        Prefix 'ATDT'
  530. Stat Capt    Current capture filename
  531. Stat Data    Current data path
  532. Stat Exit    Exit string
  533. Stat Font    Font name/size
  534. Stat History    History buffer
  535. Stat Init    Init string
  536. Stat Line    Current input line
  537. Stat Macro    Key macro filename
  538. Stat Name    Last file uploaded or downloaded.  Can also be used to
  539.         get file in requester while up or after closing.
  540. Stat OutPre    Output pre-insert string.
  541. Stat Phone    Current phonebook filename.
  542. Stat Q        Current phonebook line.
  543. Stat Serial    Current serial device.
  544. Stat Trans    Current transfer protocol.
  545. Stat U        CHAT user string or last line selected in review window.
  546. Stat Version    Program name and version.
  547. Stat Word    Current word in outgoing buffer.
  548. Stat X        Last file transfered with full path.  Can also be used to
  549.         get path/file in requester while up or after closing.
  550. Stat Y        Online timer (format ' h:mm:ss')
  551. Stat Z        Transfer status line
  552. Stat %N     (N = A thru Z)  Hot keys A thru Z
  553.  
  554. 'OPTIONS RESULTS' must be set.
  555.  
  556. Returns:
  557.     String is returned in RESULT
  558.  
  559. --------------------------------------------------------------------------
  560. Timeout     Set WAIT timeouts in seconds.
  561.  
  562. Timeout 3    All WAITS will return non-zero in RC if no serial activity
  563.         for 3 seconds.
  564.         PULL will signal break_c
  565.  
  566. Timeout OFF    Disable timeouts
  567.  
  568. See also: Wait
  569. --------------------------------------------------------------------------
  570. TrueLF        Set true CR/LF mode.
  571.  
  572. True ON
  573. True OFF
  574.  
  575. --------------------------------------------------------------------------
  576. Upload        Upload one or more files separated by commas.
  577.  
  578. Up 'file.arc'    Upload this filename in the current datapath
  579.         using the current transfer protocol.
  580. Up 'one,two'    Upload the files named "one" and "two" (zmodem & ymodem)
  581.  
  582. See also: DataPath, DownLoad
  583. --------------------------------------------------------------------------
  584. Undo        Insert string into CHAT window
  585.  
  586. Undo 'string'
  587.  
  588. See also: Status U, Chat
  589. --------------------------------------------------------------------------
  590. Wait        Stop an ARexx process until a string or one of the
  591.         multiple strings separated by commas are found or
  592.         timeout occurs.
  593.  
  594. Wait password    Wait until anything with 'password' in it is found.
  595.  
  596. Wait 'pa??'    Will find pass, part, page, PAGE, ect.
  597.  
  598. Wait '0A'x' '    Will find a linefeed with a space after it.
  599.  
  600. Wait 'xx,yy,zz' Will find xx, yy, or zz.
  601.  
  602. Wait '?'    Wait for next character
  603.  
  604. Returns:
  605.     RC is non-zero if timeout occurred.
  606.     If OPTIONS RESULTS is set, the string found is returned.
  607.     ?'s are replaced with characters.
  608.  
  609. See also: Timeout
  610. --------------------------------------------------------------------------
  611. Wrap        Set word wrap length
  612.  
  613. Wrap ON        on with default columns
  614. Wrap OFF    off
  615. Wrap 80     on with 80 columns
  616.  
  617. --------------------------------------------------------------------------
  618.  
  619.  
  620.  
  621. Standard ARexx commands inherited by BaudBandit
  622. --------------------------------------------------------------------------
  623. Say        Print text on the screen.
  624.         If remote echo is on, it is sent to the modem also.
  625.  
  626. --------------------------------------------------------------------------
  627. Pull        Get user input string.
  628.         Normally gets input from the modem.
  629.         If duplex is half, input is from modem and keyboard.
  630.         If quiet is also enabled, input is from keyboard only.
  631.  
  632. --------------------------------------------------------------------------
  633. Push        Insert (add) lines onto the end of the chat history buffer
  634.  
  635. --------------------------------------------------------------------------
  636. Queue        Sends text in KeyMap format to BaudBandit as if typed by
  637.         the user.  (For cursors, Fkeys, ect. see the RKM)
  638.  
  639. --------------------------------------------------------------------------
  640.